-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Add instructions for building the docs #982
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok to merge?
Two changes:
|
Off the top of my head, I believe this is only true for the 1. the clearsky page's tables requirement and 2. the forecast page's netcdf/siphon requirement. Am I missing anything? If it's just those then maybe add them to the doc requirement. If it's more then maybe make doc an extension of optional instead of instructing users to install both.
What makes you think this is the case? I don't have pillow and can build the docs just fine. |
Good idea about only adding what is needed to the doc requirement. I'll try it out.
In a fresh environment without pillow the build fails with this:
You can do a build from scratch without pillow or PIL? Sphinx-gallery's readme says it is a (possibly unnecessary) untracked dependency: https://github.com/sphinx-gallery/sphinx-gallery |
Indeed building the docs does now require pillow. I was confused about environment/git status. Sorry. |
The example gallery adds another layer since those actually run functions instead of just importing modules. I think the only addition to your list is scipy (for plot_singlediode.py). It's still less than half of the |
I think many of us previously agreed (over many issues/prs) that it would be good to add scipy to the base requirements. So that would resolve the concern over the additional dependency. I can go either way on the lean vs. batteries-included doc list. In either case do we need to change something about the readthedocs configuration so that we can more reliably test the doc build? |
I suppose if That way the RTD build would presumably fail if we add a new requirement but forget to add it to the |
Ok, looks like the RTD build worked with only the updated [doc] list. I also turned off the setting to use preinstalled system packages so that (I think) it only uses the packages specified in setup.py. I left scipy as an optional/doc requirement for now, since I assume making it base requirement will be a bit of a bigger job than just editing setup.py. Anything else to do for this PR? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @kanderso-nrel!
Closes #xxxxTests addedUpdates entries todocs/sphinx/source/api.rst
for API changes.docs/sphinx/source/whatsnew
for all changes. Includes link to the GitHub Issue with:issue:`num`
or this Pull Request with:pull:`num`
. Includes contributor name and/or GitHub username (link with:ghuser:`user`
).New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.